Skip to content

[Backport v3.7-branch] logging: fixes and enhancements to initialization and shell cmds #89318

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Jump to bottom
Merged
merged 2 commits into from
Jun 18, 2025
Merged

[Backport v3.7-branch] logging: fixes and enhancements to initialization and shell cmds #89318

merged 2 commits into from
Jun 18, 2025

Conversation

@ycsin
Copy link
Member

@ycsin ycsin commented Apr 30, 2025 •
edited
Loading

Backport from #84955 + #87097

The fix in #84955 introduce a bug which is fixed later by #87097, this PR is a combination of both, so that it fixes things without introducing bugs

Fixes #84952

Test

west build -b qemu_riscv64 -p auto -t run zephyr/samples/hello_world -- -DCONFIG_LOG=y -DCONFIG_SHELL=y -DCONFIG_LOG_CMDS=y -DCONFIG_LOG_BACKEND_UART=y -DCONFIG_LOG_BACKEND_UART_AUTOSTART=n

Before the patch

Full console log 
Hello World! qemu_riscv64/qemu_virt_riscv64


*** Booting Zephyr OS build v3.7.1-113-gcab2f9d27f3e ***
uart:~$ log list_backends
log_backend_uart
        - Status: disabled
        - ID: 0

shell_uart_backend
        - Status: enabled
        - ID: 2

uart:~$ log backend shell_uart_backend status
module_name                              | current | built-in 
----------------------------------------------------------
cbprintf_package                         | inf     | inf
getopt                                   | inf     | inf
log                                      | inf     | inf
log_mgmt                                 | inf     | inf
log_uart                                 | inf     | inf
mpu                                      | inf     | inf
os                                       | inf     | inf
shell.shell_uart                         | inf     | inf
shell_uart                               | inf     | inf
uart_ns16550                             | inf     | inf
uart:~$ log backend log_backend_uart status
Logs are halted!
module_name                              | current | built-in 
----------------------------------------------------------
cbprintf_package                         | inf     | inf
getopt                                   | inf     | inf
log                                      | inf     | inf
log_mgmt                                 | inf     | inf
log_uart                                 | inf     | inf
mpu                                      | inf     | inf
os                                       | inf     | inf
shell.shell_uart                         | inf     | inf
shell_uart                               | inf     | inf
uart_ns16550                             | inf     | inf
uart:~$ log backend shell_uart_backend enable wrn
uart:~$ log backend shell_uart_backend status
module_name                              | current | built-in 
----------------------------------------------------------
cbprintf_package                         | wrn     | inf
getopt                                   | wrn     | inf
log                                      | wrn     | inf
log_mgmt                                 | wrn     | inf
log_uart                                 | wrn     | inf
mpu                                      | wrn     | inf
os                                       | wrn     | inf
shell.shell_uart                         | wrn     | inf
shell_uart                               | wrn     | inf
uart_ns16550                             | wrn     | inf
uart:~$ log backend log_backend_uart status
Logs are halted!
module_name                              | current | built-in 
----------------------------------------------------------
cbprintf_package                         | wrn     | inf
getopt                                   | wrn     | inf
log                                      | wrn     | inf
log_mgmt                                 | wrn     | inf
log_uart                                 | wrn     | inf
mpu                                      | wrn     | inf
os                                       | wrn     | inf
shell.shell_uart                         | wrn     | inf
shell_uart                               | wrn     | inf
uart_ns16550                             | wrn     | inf
uart:~$

After the patch:

Hello World! qemu_riscv64/qemu_virt_riscv64


*** Booting Zephyr OS build v3.7.1-115-gd9d6b62c29d5 ***
uart:~$ log list_backends
log_backend_uart
        - Status: disabled
        - ID: 1

shell_uart_backend
        - Status: enabled
        - ID: 2

uart:~$ log backend shell_uart_backend status
module_name                              | current | built-in 
----------------------------------------------------------
cbprintf_package                         | inf     | inf
getopt                                   | inf     | inf
log                                      | inf     | inf
log_mgmt                                 | inf     | inf
log_uart                                 | inf     | inf
mpu                                      | inf     | inf
os                                       | inf     | inf
shell.shell_uart                         | inf     | inf
shell_uart                               | inf     | inf
uart_ns16550                             | inf     | inf
uart:~$ log backend log_backend_uart status
Logs are halted!
module_name                              | current | built-in 
----------------------------------------------------------
cbprintf_package                         | none    | inf
getopt                                   | none    | inf
log                                      | none    | inf
log_mgmt                                 | none    | inf
log_uart                                 | none    | inf
mpu                                      | none    | inf
os                                       | none    | inf
shell.shell_uart                         | none    | inf
shell_uart                               | none    | inf
uart_ns16550                             | none    | inf
uart:~$ log backend shell_uart_backend enable wrn
uart:~$ log backend shell_uart_backend status
module_name                              | current | built-in 
----------------------------------------------------------
cbprintf_package                         | wrn     | inf
getopt                                   | wrn     | inf
log                                      | wrn     | inf
log_mgmt                                 | wrn     | inf
log_uart                                 | wrn     | inf
mpu                                      | wrn     | inf
os                                       | wrn     | inf
shell.shell_uart                         | wrn     | inf
shell_uart                               | wrn     | inf
uart_ns16550                             | wrn     | inf
uart:~$ log backend log_backend_uart status
Logs are halted!
module_name                              | current | built-in 
----------------------------------------------------------
cbprintf_package                         | none    | inf
getopt                                   | none    | inf
log                                      | none    | inf
log_mgmt                                 | none    | inf
log_uart                                 | none    | inf
mpu                                      | none    | inf
os                                       | none    | inf
shell.shell_uart                         | none    | inf
shell_uart                               | none    | inf
uart_ns16550                             | none    | inf
uart:~$

@ycsin ycsin changed the base branch from main to v3.7-branch April 30, 2025 12:21
@ycsin ycsin mentioned this pull request Apr 30, 2025
Closed
@ycsin ycsin marked this pull request as ready for review April 30, 2025 13:27
@ycsin ycsin added the Backport Backport PR and backport failure issues label Apr 30, 2025
@github-project-automation github-project-automation bot moved this to To do in Backports Apr 30, 2025
ycsin and others added 2 commits June 18, 2025 07:44
@ycsin @nashif
logging: init backend id regardless of autostart
3d9e7f0 
The `id` is basically a compile-time constant. Setting it every
time the backend is enabled is unnecessary. Instead, set it on
`log_core_init()` regardless of whether or not it requires to be
`autostart`ed.

Fixes an issue where the `filter_get`/`filter_set`
accessed the wrong index and displayed the wrong log level when
user accesses the status of an uninitialized backend via:
`log backend <uninitialized_backend> status`.

Also fixes an issue when user tries to list the backends via:
`log list_backends`, where all uninitialized backends will have
ID = 0.

This commit is a combination of 8dd9d92 & dd9fd7d.

Signed-off-by: Yong Cong Sin <[email protected]>
Signed-off-by: Yong Cong Sin <[email protected]>
@ycsin @nashif
logging: log_cmds: init uninitialized backend on log_go()
9e927fb 
For backends that do not autostart themselves, initialize
& enable them on `log backend <log_backend_*> go`, so
that they function properly.

Signed-off-by: Yong Cong Sin <[email protected]>
Signed-off-by: Yong Cong Sin <[email protected]>
@nashif nashif force-pushed the pr/v3.7-branch-backport-85159 branch from d9d6b62 to 9e927fb Compare June 18, 2025 11:44
@sonarqubecloud
Copy link

sonarqubecloud bot commented Jun 18, 2025

Quality Gate Passed Quality Gate passed

Issues
0 New issues
0 Accepted issues

Measures
0 Security Hotspots
0.0% Coverage on New Code
0.0% Duplication on New Code

See analysis details on SonarQube Cloud

@nashif nashif merged commit 7cfc153 into zephyrproject-rtos:v3.7-branch Jun 18, 2025
25 checks passed
@github-project-automation github-project-automation bot moved this from To do to Done in Backports Jun 18, 2025
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Reviewers

@nordic-krch nordic-krch nordic-krch approved these changes

@kwd-doodling kwd-doodling kwd-doodling approved these changes

@dcpleung dcpleung Awaiting requested review from dcpleung

@kartben kartben Awaiting requested review from kartben

@nashif nashif Awaiting requested review from nashif

Assignees

@nordic-krch nordic-krch

Labels

area: Logging Backport Backport PR and backport failure issues

Projects

Backports
Status: Done

Milestone

No milestone

Development

Successfully merging this pull request may close these issues.

logging: log_cmds: backend ID is wrong for backend(s) that do not autostart

4 participants

@ycsin @nordic-krch @kwd-doodling @nashif